<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Tutorial - Boost.Outcome documentation</title>
<link rel="stylesheet" href="./css/boost.css" type="text/css">
<meta name="generator" content="Hugo 0.52 with Boostdoc theme">
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>

<link rel="icon" href="./images/favicon.ico" type="image/ico"/>
<body><div class="spirit-nav">
<a accesskey="p" href="./motivation/narrow_contract.html"><img src="./images/prev.png" alt="Prev"></a>
    <a accesskey="u" href="./index.html"><img src="./images/up.png" alt="Up"></a>
    <a accesskey="h" href="./index.html"><img src="./images/home.png" alt="Home"></a><a accesskey="n" href="./tutorial/essential.html"><img src="./images/next.png" alt="Next"></a></div><div id="content">

  <div class="titlepage"><div><div><h1 style="clear: both">Tutorial</h1></div></div></div>
<ol class="children children-li"><li>
	<a href="./tutorial/essential.html" >Essential</a>
<p>The absolute minimum that you need to know to get started with Outcome immediately.</p><ol><li>
	<a href="./tutorial/essential/before.html" >Before we begin</a>
<p>Essential information before you begin the tutorial.</p><li>
	<a href="./tutorial/essential/result.html" >result&lt;&gt;</a>
<p>Gentle introduction to writing code with simple success-or-failure return types.</p><li>
	<a href="./tutorial/essential/outcome.html" >outcome&lt;&gt;</a>
<p>Success-or-failure return types where failure can take two forms, expected/handled failure and unexpected/abort failure.</p><li>
	<a href="./tutorial/essential/no-value.html" >No-value policies</a>
<p>Describes the concept of NoValuePolicy and how to use no-value policies.</p><li>
	<a href="./tutorial/essential/coroutines.html" >Coroutines</a>
<p>Using Outcome in C++ Coroutines</p><li>
	<a href="./tutorial/essential/conventions.html" >Conventions</a>
<p>Why you should avoid custom <code>E</code> types in public APIs.</p></li></ol><li>
	<a href="./tutorial/advanced.html" >Advanced</a>
<p>If you have a bit more time, this covers all the time-saving ways you can customise and automate Outcome for various use cases, especially in larger codebases made up of multiple third party libraries.</p><ol><li>
	<a href="./tutorial/advanced/payload.html" >Custom payloads</a>
<p>Success-or-failure return types where extra information in addition to the error code accompanies failure.</p><li>
	<a href="./tutorial/advanced/constructors.html" >Result returning constructors</a>
<p>How to metaprogram construction of objects which use result<T, EC> to return failure instead of throwing a C++ exception.</p><li>
	<a href="./tutorial/advanced/hooks.html" >Hooking events</a>
<p>Intercepting useful events such as initial construction, copies and moves so you can capture backtraces, fire debug breakpoints etc.</p><li>
	<a href="./tutorial/advanced/interop.html" >Interoperation</a>
<p>Interoperating with std::expected<T, E> and other ValueOrError concept matching types.</p></li></ol></li></ol>








        </div><p><small>Last revised: December 15, 2020 at 12:22:39 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="./motivation/narrow_contract.html"><img src="./images/prev.png" alt="Prev"></a>
    <a accesskey="u" href="./index.html"><img src="./images/up.png" alt="Up"></a>
    <a accesskey="h" href="./index.html"><img src="./images/home.png" alt="Home"></a><a accesskey="n" href="./tutorial/essential.html"><img src="./images/next.png" alt="Next"></a></div></body>
</html>
